unset-value

What is unset-value?

The unset-value npm package is used to remove properties from an object. It allows you to delete a nested property from an object using a dot-path or an array of keys without mutating the original object.

What are unset-value's main functionalities?

Unsetting a property using a dot-path

This feature allows you to remove a nested property from an object by specifying the path to the property using a string with dot notation. For example, if you have an object `{ a: { b: { c: 7 } } }` and you want to remove the property `c`, you can use `unset(object, 'a.b.c')`.

{"object": {"a": {"b": {"c": 7}}}, "path": "a.b.c"}

Unsetting a property using an array of keys

This feature is similar to the dot-path method but uses an array of keys to specify the path to the property. It is useful when property names are dynamic or not valid identifiers. For example, `unset(object, ['a', 'b', 'c'])` will remove the property `c` from the object.

{"object": {"a": {"b": {"c": 7}}}, "path": ["a", "b", "c"]}

Other packages similar to unset-value

lodash.unset

Lodash's unset function is a part of the larger Lodash utility library. It offers similar functionality to unset-value, allowing you to remove nested properties from objects. Lodash is a well-established library with a wide range of utility functions, but it is larger in size compared to the focused unset-value package.

dot-prop

Dot-prop is a package that allows you to get, set, or delete properties from a nested object using a dot path. While it provides similar functionality for deleting properties, it also includes methods for getting and setting values, making it more versatile but also broader in scope than unset-value.

README

unset-value

Delete nested properties from an object using dot notation.

Install

Install with npm:

$ npm install --save unset-value

Usage

var unset = require('unset-value');

var obj = {a: {b: {c: 'd', e: 'f'}}};
unset(obj, 'a.b.c');
console.log(obj);
//=> {a: {b: {e: 'f'}}};

Examples

Updates the object when a property is deleted

var obj = {a: 'b'};
unset(obj, 'a');
console.log(obj);
//=> {}

Returns true when a property is deleted

unset({a: 'b'}, 'a') // true

Returns true when a property does not exist

This is consistent with delete behavior in that it does not throw when a property does not exist.

unset({a: {b: {c: 'd'}}}, 'd') // true

delete nested values

var one = {a: {b: {c: 'd'}}};
unset(one, 'a.b');
console.log(one);
//=> {a: {}}

var two = {a: {b: {c: 'd'}}};
unset(two, 'a.b.c');
console.log(two);
//=> {a: {b: {}}}

var three = {a: {b: {c: 'd', e: 'f'}}};
unset(three, 'a.b.c');
console.log(three);
//=> {a: {b: {e: 'f'}}}

throws on invalid args

unset();
// 'expected an object.'

About

Related projects

• get-value: Use property paths (a.b.c) to get a nested value from an object. | homepage
• get-values: Return an array of all values from the given object. | homepage
• omit-value: Omit properties from an object or deeply nested property of an object using object path… more | homepage
• put-value: Update only existing values from an object, works with dot notation paths like a.b.c and… more | homepage
• set-value: Create nested values and any intermediaries using dot notation ('a.b.c') paths. | homepage
• union-value: Set an array of unique values as the property of an object. Supports setting deeply… more | homepage
• upsert-value: Update or set nested values and any intermediaries with dot notation ('a.b.c') paths. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits	Contributor
6	jonschlinkert
2	wtgtybhertgeghgtwtg

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.4.2, on February 25, 2017.